home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / X11 / XOpenIM.z / XOpenIM
Encoding:
Text File  |  2002-10-03  |  8.8 KB  |  199 lines
  1.  
  2.  
  3.  
  4.      XXXXOOOOppppeeeennnnIIIIMMMM((((3333XXXX11111111))))      XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))       XXXXOOOOppppeeeennnnIIIIMMMM((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XOpenIM, XCloseIM, XSetIMValues, XGetIMValues, XDisplayOfIM,
  10.           XLocaleOfIM, XRegisterIMInstantiateCallback,
  11.           XUnregisterIMInstantiateCallback - open, close, and otain
  12.           input method information
  13.  
  14.      SSSSYYYYNNNNTTTTAAAAXXXX
  15.           XIM XOpenIM(_d_i_s_p_l_a_y, _d_b, _r_e_s__n_a_m_e, _r_e_s__c_l_a_s_s)
  16.                 Display *_d_i_s_p_l_a_y;
  17.                 XrmDatabase _d_b;
  18.                 char *_r_e_s__n_a_m_e;
  19.                 char *_r_e_s__c_l_a_s_s;
  20.  
  21.           Status XCloseIM(_i_m)
  22.                 XIM _i_m;
  23.  
  24.           char * XSetIMValues(_i_m, ...)
  25.                 XIM _i_m;
  26.  
  27.           char * XGetIMValues(_i_m, ...)
  28.                 XIM _i_m;
  29.  
  30.           Display * XDisplayOfIM(_i_m)
  31.                XIM _i_m;
  32.  
  33.           char * XLocaleOfIM(_i_m)
  34.                 XIM _i_m;
  35.  
  36.           Bool XRegisterIMInstantiateCallback(_d_i_s_p_l_a_y, _d_b, _r_e_s__n_a_m_e,
  37.           _r_e_s__c_l_a_s_s, _c_a_l_l_b_a_c_k, _c_l_i_e_n_t__d_a_t_a)
  38.                 Display *_d_i_s_p_l_a_y;
  39.                 XrmDatabase _d_b;
  40.                 char *_r_e_s__n_a_m_e;
  41.                 char *_r_e_s__c_l_a_s_s;
  42.                 XIMProc  _c_a_l_l_b_a_c_k;
  43.                 XPointer *_c_l_i_e_n_t__d_a_t_a;
  44.  
  45.           Bool XUnregisterIMInstantiateCallback(_d_i_s_p_l_a_y, _d_b, _r_e_s__n_a_m_e,
  46.           _r_e_s__c_l_a_s_s, _c_a_l_l_b_a_c_k, _c_l_i_e_n_t__d_a_t_a)
  47.                 Display *_d_i_s_p_l_a_y;
  48.                 XrmDatabase _d_b;
  49.                 char *_r_e_s__n_a_m_e;
  50.                 char *_r_e_s__c_l_a_s_s;
  51.                 XIMProc  _c_a_l_l_b_a_c_k;
  52.                 XPointer *_c_l_i_e_n_t__d_a_t_a;
  53.  
  54.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  55.           _c_a_l_l_b_a_c_k  Specifies a pointer to the input method
  56.                     instantiate callback.
  57.  
  58.           _c_l_i_e_n_t__d_a_t_a
  59.                     Specifies the additional client data.
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXOOOOppppeeeennnnIIIIMMMM((((3333XXXX11111111))))      XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))       XXXXOOOOppppeeeennnnIIIIMMMM((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.           _d_b        Specifies a pointer to the resource database.
  75.  
  76.           _d_i_s_p_l_a_y   Specifies the connection to the X server.
  77.  
  78.           _i_m        Specifies the input method.
  79.  
  80.           _r_e_s__c_l_a_s_s Specifies the full class name of the application.
  81.  
  82.           _r_e_s__n_a_m_e  Specifies the full resource name of the
  83.                     application.
  84.  
  85.           ...       Specifies the variable length argument list to set
  86.                     or get XIM values.
  87.  
  88.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  89.           The _X_O_p_e_n_I_M function opens an input method, matching the
  90.           current locale and modifiers specification.  Current locale
  91.           and modifiers are bound to the input method at opening time.
  92.           The locale associated with an input method cannot be changed
  93.           dynamically.  This implies that the strings returned by
  94.           _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g or _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g, for any input context
  95.           affiliated with a given input method will be encoded in the
  96.           locale current at the time the input method is opened.
  97.  
  98.           The specific input method to which this call will be routed
  99.           is identified on the basis of the current locale. _X_O_p_e_n_I_M
  100.           will identify a default input method corresponding to the
  101.           current locale.  That default can be modified using
  102.           _X_S_e_t_L_o_c_a_l_e_M_o_d_i_f_i_e_r_s for the input method modifier.
  103.  
  104.           The db argument is the resource database to be used by the
  105.           input method for looking up resources that are private to
  106.           the input method.  It is not intended that this database be
  107.           used to look up values that can be set as IC values in an
  108.           input context.  If db is NULL, no database is passed to the
  109.           input method.
  110.  
  111.           The res_name and res_class arguments specify the resource
  112.           name and class of the application. They are intended to be
  113.           used as prefixes by the input method when looking up
  114.           resources that are common to all input contexts that may be
  115.           created for this input method.  The characters used for
  116.           resource names and classes must be in the X Portable
  117.           Character Set.  The resources looked up are not fully
  118.           specified if res_name or res_class is NULL.
  119.  
  120.           The res_name and res_class arguments are not assumed to
  121.           exist beyond the call to _X_O_p_e_n_I_M.  The specified resource
  122.           database is assumed to exist for the lifetime of the input
  123.           method.
  124.  
  125.           _X_O_p_e_n_I_M returns NULL if no input method could be opened.
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXOOOOppppeeeennnnIIIIMMMM((((3333XXXX11111111))))      XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))       XXXXOOOOppppeeeennnnIIIIMMMM((((3333XXXX11111111))))
  137.  
  138.  
  139.  
  140.           The _X_C_l_o_s_e_I_M function closes the specified input method.
  141.  
  142.           The _X_S_e_t_I_M_V_a_l_u_e_s function presents a variable argument list
  143.           programming interface for setting attributes of the
  144.           specified input method.  It returns NULL if it succeeds;
  145.           otherwise, it returns the name of the first argument that
  146.           could not be set.  Xlib does not attempt to set arguments
  147.           from the supplied list that follow the failed argument; all
  148.           arguments in the list preceding the failed argument have
  149.           been set correctly.
  150.  
  151.           The _X_G_e_t_I_M_V_a_l_u_e_s function presents a variable argument list
  152.           programming interface for querying properties or features of
  153.           the specified input method.  This function returns NULL if
  154.           it succeeds; otherwise, it returns the name of the first
  155.           argument that could not be obtained.
  156.  
  157.           Each XIM value argument (following a name) must point to a
  158.           location where the XIM value is to be stored.  That is, if
  159.           the XIM value is of type T, the argument must be of type T*.
  160.           If T itself is a pointer type, then _X_G_e_t_I_M_V_a_l_u_e_s allocates
  161.           memory to store the actual data, and the client is
  162.           responsible for freeing this data by calling _X_F_r_e_e with the
  163.           returned pointer.
  164.  
  165.           The _X_D_i_s_p_l_a_y_O_f_I_M function returns the display associated
  166.           with the specified input method.
  167.  
  168.           The _X_L_o_c_a_l_e_O_f_I_M function returns the locale associated with
  169.           the specified input method.
  170.  
  171.           The _X_R_e_g_i_s_t_e_r_I_M_I_n_s_t_a_n_t_i_a_t_e_C_a_l_l_b_a_c_k function registers a
  172.           callback to be invoked whenever a new input method becomes
  173.           available for the specified display that matches the current
  174.           locale and modifiers.
  175.  
  176.           The function returns _T_r_u_e
  177.            if it succeeds; otherwise, it returns _F_a_l_s_e.
  178.  
  179.           The _X_U_n_r_e_g_i_s_t_e_r_I_M_I_n_s_t_a_n_t_i_a_t_e_C_a_l_l_b_a_c_k function removes an
  180.           input method instantiation callback previously registered.
  181.           The function returns _T_r_u_e if it succeeds; otherwise, it
  182.           returns _F_a_l_s_e.
  183.  
  184.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  185.           XCreateIC(3X11), XSetICFocus(3X11), XSetICValues(3X11),
  186.           XmbResetIC(3X11)
  187.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 10/3/02)
  196.  
  197.  
  198.  
  199.